Field Detail

• Values!

  public JsonArray Values!

  The values to display in the filter. If this is not set, then the filter will takes its values from what is loaded in the table. Setting it allows you to set values where the value may not be present in the list for example, if you want to show all states in America so that the user is not confused by missing states, even though states are missing from the data set in the grid

Constructor Detail

• GxClientFilterSetFilterModel

  public GxClientFilterSetFilterModel(JsonArray values!)

  Construct new GxClientFilterSetFilterModel

  Parameters:

  JsonArray values! The values to display in the filter

Method Detail

• clearFilter

  public void clearFilter()

  Clear the filter

  Returns:

  BBjString the js code used to clear the filter

• execute

  public BBjString execute(BBjNumber send!)

  Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.

  Parameters:

  BBjNumber send! when true the execution code will executed on the client , false otherwise

  Throws:

  256 when the column or the widget are not defined

• getAsJsonObject

  public JsonObject getAsJsonObject()

  {@inheritDoc}

• getMiniFilter

  public BBjString getMiniFilter()

  Get the mini filter value.

  Note that if the grid is not ready , then this method will always return an empty string even if you have called setMiniFilter before.

  
  #API

  Returns:

  BBjString

  Throws:

  256 when the column or the widget are not defined

• selectEverything

  public void selectEverything()

  Select all values generated by the UI

  
  #API

• selectNothing

  public void selectNothing()

  Clears the selection

  
  #API

• selectValue

  public void selectValue(BBjString value!)

  Selects a value

  
  #API

  Parameters:

  BBjString value! the value to select

  Throws:

  256 when the column or the widget are not defined

• selectValue

  public void selectValue(BBjNumber value!)

  Selects a value

  
  #API

  Parameters:

  BBjNumber value! the value to select

  Throws:

  256 when the column or the widget are not defined

• setFilterValues

  public void setFilterValues(JsonArray values!)

  Change on the fly the available options

  
  #API

  Parameters:

  JsonArray values! array of values

  Throws:

  256 when the column or the widget are not defined

• setMiniFilter

  public void setMiniFilter(BBjString miniFilter!)

  Sets the filter at the top of the filter (the 'quick search' in the popup)

  
  #API

  Parameters:

  BBjString miniFilter

  Throws:

  256 when the column or the widget are not defined

• setMiniFilter

  public void setMiniFilter(BBjNumber miniFilter!)

  Sets the filter at the top of the filter (the 'quick search' in the popup)

  
  #API

  Parameters:

  BBjNumber miniFilter

  Throws:

  256 when the column or the widget are not defined

• supportsCombinedModel

  public BBjNumber supportsCombinedModel()

  {@inheritDoc}

• unselectValue

  public void unselectValue(BBjString value!)

  Unselects a value

  
  #API

  Parameters:

  BBjString value! the value to unselect

  Throws:

  256 when the column or the widget are not defined

• unselectValue

  public void unselectValue(BBjNumber value!)

  Unselects a value

  
  #API

  Parameters:

  BBjNumber value! the value to unselect

  Throws:

  256 when the column or the widget are not defined